Telegram Bot/eu.vendeli.tgbot.types.internal.options

Package-level declarations

Types

@Serializable

data class AnimationOptions(var duration: Int? = null, var width: Int? = null, var height: Int? = null, var allowPaidBroadcast: Boolean? = null, var thumbnail: ImplicitFile? = null, var showCaptionAboveMedia: Boolean? = null, var parseMode: ParseMode? = null, var disableNotification: Boolean? = null, var replyParameters: ReplyParameters? = null, var protectContent: Boolean? = null, var messageThreadId: Int? = null, var hasSpoiler: Boolean? = null, var messageEffectId: String? = null) : OptionsCommon, ForumProps, OptionsParseMode, MediaSpoiler, MessageEffectIdProp, ThumbnailProp, ShowCaptionAboveMediaProp

AnswerCallbackQueryOptions

@Serializable

data class AnswerCallbackQueryOptions(var text: String? = null, var showAlert: Boolean? = null, var url: String? = null, var cacheTime: Int? = null) : Options

AnswerInlineQueryOptions

@Serializable

data class AnswerInlineQueryOptions(var cacheTime: Int? = null, var isPersonal: Boolean? = null, var nextOffset: String? = null, var button: InlineQueryResultsButton? = null) : Options

AudioOptions

@Serializable

data class AudioOptions(var parseMode: ParseMode? = null, var duration: Int? = null, var performer: String? = null, var title: String? = null, var allowPaidBroadcast: Boolean? = null, var thumbnail: ImplicitFile? = null, var disableNotification: Boolean? = null, var protectContent: Boolean? = null, var replyParameters: ReplyParameters? = null, var messageThreadId: Int? = null, var messageEffectId: String? = null) : OptionsCommon, ForumProps, OptionsParseMode, ThumbnailProp, MessageEffectIdProp

ChatInviteLinkOptions

@Serializable

data class ChatInviteLinkOptions(var name: String? = null, var expireDate: Instant? = null, var memberLimit: Int? = null, var createsJoinRequest: Boolean? = null) : Options

ContactOptions

@Serializable

data class ContactOptions(var lastName: String? = null, var vcard: String? = null, var allowPaidBroadcast: Boolean? = null, var disableNotification: Boolean? = null, var replyParameters: ReplyParameters? = null, var protectContent: Boolean? = null, var messageThreadId: Int? = null, var messageEffectId: String? = null) : OptionsCommon, ForumProps, MessageEffectIdProp

CopyMessageOptions

@Serializable

data class CopyMessageOptions(var showCaptionAboveMedia: Boolean? = null, var disableNotification: Boolean? = null, var protectContent: Boolean? = null, var parseMode: ParseMode? = null, var replyParameters: ReplyParameters? = null, var messageThreadId: Int? = null, var allowPaidBroadcast: Boolean? = null) : OptionsParseMode, ForumProps, OptionsCommon, ShowCaptionAboveMediaProp

CopyMessagesOptions

@Serializable

data class CopyMessagesOptions(var messageThreadId: Int? = null, var disableNotification: Boolean? = null, var protectContent: Boolean? = null, var removeCaption: Boolean? = null) : Options

CreateInvoiceLinkOptions

@Serializable

data class CreateInvoiceLinkOptions(var providerToken: String? = null, var maxTipAmount: Int? = null, var suggestedTipAmounts: List<Int>? = null, var providerData: String? = null, var photoUrl: String? = null, var photoSize: Long? = null, var photoWidth: Int? = null, var photoHeight: Int? = null, var needName: Boolean? = null, var subscriptionPeriod: Duration? = null, var needPhoneNumber: Boolean? = null, var needEmail: Boolean? = null, var needShippingAddress: Boolean? = null, var sendPhoneNumberToProvider: Boolean? = null, var sendEmailToProvider: Boolean? = null, var isFlexible: Boolean? = null) : Options

Create invoice link options

CreateNewStickerSetOptions

@Serializable

data class CreateNewStickerSetOptions(var stickerType: StickerType? = null, var needsRepainting: Boolean? = null) : Options

DiceOptions

@Serializable

data class DiceOptions(var disableNotification: Boolean? = null, var replyParameters: ReplyParameters? = null, var protectContent: Boolean? = null, var messageThreadId: Int? = null, var messageEffectId: String? = null, var allowPaidBroadcast: Boolean? = null) : OptionsCommon, ForumProps, MessageEffectIdProp

DocumentOptions

@Serializable

data class DocumentOptions(var thumbnail: ImplicitFile? = null, var disableContentTypeDetection: Boolean? = null, var parseMode: ParseMode? = null, var disableNotification: Boolean? = null, var replyParameters: ReplyParameters? = null, var protectContent: Boolean? = null, var messageThreadId: Int? = null, var messageEffectId: String? = null, var allowPaidBroadcast: Boolean? = null) : OptionsCommon, ForumProps, OptionsParseMode, ThumbnailProp, MessageEffectIdProp

EditCaptionOptions

@Serializable

data class EditCaptionOptions(var showCaptionAboveMedia: Boolean? = null, var parseMode: ParseMode? = null) : OptionsParseMode, ShowCaptionAboveMediaProp

EditMessageLiveLocationOptions

@Serializable

data class EditMessageLiveLocationOptions(var horizontalAccuracy: Float? = null, var heading: Int? = null, var proximityAlertRadius: Int? = null, var livePeriod: Int? = null) : Options

EditMessageOptions

@Serializable

class EditMessageOptions(var linkPreviewOptions: LinkPreviewOptions? = null, var parseMode: ParseMode? = null) : OptionsParseMode, LinkPreviewProp

ForumProps

interface ForumProps : Options

ForwardMessageOptions

@Serializable

data class ForwardMessageOptions(var disableNotification: Boolean? = null, var protectContent: Boolean? = null, var messageThreadId: Int? = null) : Options

GameOptions

@Serializable

data class GameOptions(var disableNotification: Boolean? = null, var protectContent: Boolean? = null, var replyParameters: ReplyParameters? = null, var messageThreadId: Int? = null, var messageEffectId: String? = null, var allowPaidBroadcast: Boolean? = null) : OptionsCommon, ForumProps, MessageEffectIdProp

GetUpdatesOptions

@Serializable

data class GetUpdatesOptions(var offset: Int? = null, var limit: Int? = null, var timeout: Int? = null, var allowedUpdates: List<UpdateType>? = null) : Options

InvoiceOptions

@Serializable

data class InvoiceOptions(var photoUrl: String? = null, var photoHeight: Int? = null, var photoWidth: Int? = null, var photoSize: Long? = null, var isFlexible: Boolean? = null, var needName: Boolean? = null, var needEmail: Boolean? = null, var needPhoneNumber: Boolean? = null, var needShippingAddress: Boolean? = null, var sendPhoneNumberToProvider: Boolean? = null, var sendEmailToProvider: Boolean? = null, var startParameter: String? = null, var suggestedTipAmounts: List<Int>? = null, var providerData: String? = null, var maxTipAmount: Int? = null, var allowPaidBroadcast: Boolean? = null, var protectContent: Boolean? = null, var disableNotification: Boolean? = null, var replyParameters: ReplyParameters? = null, var messageThreadId: Int? = null, var messageEffectId: String? = null) : OptionsCommon, ForumProps, MessageEffectIdProp

LinkPreviewProp

interface LinkPreviewProp : Options

LocationOptions

@Serializable

data class LocationOptions(var horizontalAccuracy: Float? = null, var livePeriod: Int? = null, var heading: Int? = null, var proximityAlertRadius: Int? = null, var disableNotification: Boolean? = null, var protectContent: Boolean? = null, var replyParameters: ReplyParameters? = null, var messageThreadId: Int? = null, var messageEffectId: String? = null, var allowPaidBroadcast: Boolean? = null) : OptionsCommon, ForumProps, MessageEffectIdProp

MediaGroupOptions

@Serializable

data class MediaGroupOptions(var disableNotification: Boolean? = null, var protectContent: Boolean? = null, var replyParameters: ReplyParameters? = null, var messageThreadId: Int? = null, var messageEffectId: String? = null, var allowPaidBroadcast: Boolean? = null) : OptionsCommon, ForumProps, MessageEffectIdProp

MediaSpoiler

interface MediaSpoiler : Options

MessageEffectIdProp

interface MessageEffectIdProp : Options

MessageOptions

@Serializable

data class MessageOptions(var linkPreviewOptions: LinkPreviewOptions? = null, var parseMode: ParseMode? = null, var protectContent: Boolean? = null, var disableNotification: Boolean? = null, var replyParameters: ReplyParameters? = null, var messageThreadId: Int? = null, var messageEffectId: String? = null, var allowPaidBroadcast: Boolean? = null) : OptionsCommon, ForumProps, OptionsParseMode, LinkPreviewProp, MessageEffectIdProp

Options

@Serializable

sealed interface Options

OptionsCommon

@Serializable

sealed interface OptionsCommon : Options

OptionsParseMode

interface OptionsParseMode : Options

PaidMediaOptions

@Serializable

data class PaidMediaOptions(var payload: String? = null, var disableNotification: Boolean? = null, var protectContent: Boolean? = null, var replyParameters: ReplyParameters? = null, var parseMode: ParseMode? = null, var showCaptionAboveMedia: Boolean? = null, var allowPaidBroadcast: Boolean? = null) : OptionsCommon, OptionsParseMode, ShowCaptionAboveMediaProp

PhotoOptions

@Serializable

data class PhotoOptions(var showCaptionAboveMedia: Boolean? = null, var parseMode: ParseMode? = null, var disableNotification: Boolean? = null, var replyParameters: ReplyParameters? = null, var protectContent: Boolean? = null, var messageThreadId: Int? = null, var hasSpoiler: Boolean? = null, var messageEffectId: String? = null, var allowPaidBroadcast: Boolean? = null) : OptionsCommon, ForumProps, OptionsParseMode, MediaSpoiler, MessageEffectIdProp, ShowCaptionAboveMediaProp

PollOptions

@Serializable

data class PollOptions(var isAnonymous: Boolean? = null, var type: PollType? = null, var allowsMultipleAnswers: Boolean? = null, var correctOptionId: Int? = null, var explanation: String? = null, var explanationParseMode: ParseMode? = null, var explanationEntities: List<MessageEntity>? = null, var openPeriod: Duration? = null, var closeDate: Instant? = null, var isClosed: Boolean? = null, var questionParseMode: ParseMode? = null, var disableNotification: Boolean? = null, var replyParameters: ReplyParameters? = null, var protectContent: Boolean? = null, var messageThreadId: Int? = null, var messageEffectId: String? = null, var allowPaidBroadcast: Boolean? = null) : OptionsCommon, ForumProps, MessageEffectIdProp

PromoteChatMemberOptions

@Serializable

data class PromoteChatMemberOptions(var isAnonymous: Boolean? = null, var canManageChat: Boolean? = null, var canPostMessages: Boolean? = null, var canEditMessages: Boolean? = null, var canDeleteMessages: Boolean? = null, var canManageVideoChats: Boolean? = null, var canRestrictMembers: Boolean? = null, var canPromoteMembers: Boolean? = null, var canChangeInfo: Boolean? = null, var canInviteUsers: Boolean? = null, var canPinMessages: Boolean? = null, var canManageTopics: Boolean? = null, var canPostStories: Boolean? = null, var canEditStories: Boolean? = null, var canDeleteStories: Boolean? = null) : Options

ReplyKeyboardMarkupOptions

@Serializable

data class ReplyKeyboardMarkupOptions(var resizeKeyboard: Boolean? = null, var oneTimeKeyboard: Boolean? = null, var inputFieldPlaceholder: String? = null, var selective: Boolean? = null, var isPersistent: Boolean? = null)

SavePreparedInlineMessageOptions

@Serializable

data class SavePreparedInlineMessageOptions(var allowUserChats: Boolean? = null, var allowBotChats: Boolean? = null, var allowGroupChats: Boolean? = null, var allowChannelChats: Boolean? = null) : Options

SetGameScoreOptions

@Serializable

data class SetGameScoreOptions(var force: Boolean? = null, var disableEditMessage: Boolean? = null) : Options

SetWebhookOptions

@Serializable

data class SetWebhookOptions(var certificate: InputFile? = null, var ipAddress: String? = null, var maxConnections: Int? = null, var allowedUpdates: List<UpdateType>? = null, var dropPendingUpdates: Boolean? = null, var secretToken: String? = null) : Options

ShowCaptionAboveMediaProp

interface ShowCaptionAboveMediaProp : Options

StickerOptions

@Serializable

data class StickerOptions(var emoji: String? = null, var disableNotification: Boolean? = null, var replyParameters: ReplyParameters? = null, var protectContent: Boolean? = null, var messageThreadId: Int? = null, var messageEffectId: String? = null, var allowPaidBroadcast: Boolean? = null) : OptionsCommon, ForumProps, MessageEffectIdProp

ThumbnailProp

interface ThumbnailProp : Options

VenueOptions

@Serializable

data class VenueOptions(var foursquareId: String? = null, var foursquareType: String? = null, var googlePlaceId: String? = null, var googlePlaceType: String? = null, var disableNotification: Boolean? = null, var replyParameters: ReplyParameters? = null, var protectContent: Boolean? = null, var messageThreadId: Int? = null, var messageEffectId: String? = null, var allowPaidBroadcast: Boolean? = null) : OptionsCommon, ForumProps, MessageEffectIdProp

VideoNoteOptions

@Serializable

data class VideoNoteOptions(var duration: Int? = null, var length: Int? = null, var thumbnail: ImplicitFile? = null, var disableNotification: Boolean? = null, var replyParameters: ReplyParameters? = null, var protectContent: Boolean? = null, var messageThreadId: Int? = null, var messageEffectId: String? = null, var allowPaidBroadcast: Boolean? = null) : OptionsCommon, ForumProps, ThumbnailProp, MessageEffectIdProp

VideoOptions

@Serializable

data class VideoOptions(var duration: Int? = null, var height: Int? = null, var width: Int? = null, var supportsStreaming: Boolean? = null, var thumbnail: ImplicitFile? = null, var showCaptionAboveMedia: Boolean? = null, var parseMode: ParseMode? = null, var disableNotification: Boolean? = null, var replyParameters: ReplyParameters? = null, var protectContent: Boolean? = null, var messageThreadId: Int? = null, var hasSpoiler: Boolean? = null, var messageEffectId: String? = null, var allowPaidBroadcast: Boolean? = null) : OptionsCommon, ForumProps, OptionsParseMode, MediaSpoiler, MessageEffectIdProp, ThumbnailProp, ShowCaptionAboveMediaProp

VoiceOptions

@Serializable

data class VoiceOptions(var parseMode: ParseMode? = null, var duration: Int? = null, var disableNotification: Boolean? = null, var protectContent: Boolean? = null, var replyParameters: ReplyParameters? = null, var messageThreadId: Int? = null, var messageEffectId: String? = null, var allowPaidBroadcast: Boolean? = null) : OptionsCommon, ForumProps, OptionsParseMode, MessageEffectIdProp